Retrieve agent configuration

GET

https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies/{admPolicyId}/agent-config

curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies/{admPolicyId}/agent-config" \
  -H "Authorization: Bearer <YOUR_API_KEY>"

const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies/{admPolicyId}/agent-config", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies/{admPolicyId}/agent-config",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

admPolicyId string

required

Apple device policy unique identifier used in URL path for retrieving or modifying specific policy configuration.

Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json

status boolean optional

data object optional

config object optional

Global MDM agent configuration settings defining polling intervals refresh actions and operational parameters across platforms.

checkInterval integer optional

MDM agent polling interval in seconds defining how frequently device checks for policy updates and pending commands.

≥ 0

allowRefreshAction boolean optional

Flag enabling manual refresh action in MDM agent allowing users to force immediate policy synchronization.

ios object optional

iOS and iPadOS specific MDM agent configuration settings controlling location tracking app monitoring and data collection behavior.

location object optional

iOS location tracking configuration defining polling frequency and data queue limits for geofencing and asset management.

applicationsTime object optional

iOS application usage time tracking configuration defining data collection frequency queue limits and report batch sizing.

applicationsTransfer object optional

iOS application network data transfer monitoring configuration defining bandwidth tracking frequency and reporting parameters for security analysis.

networkStatus object optional

policyFeatures array [object] optional

macos object optional

macOS specific MDM agent configuration settings controlling location scripts device information and application monitoring behavior.

location object optional

macOS location tracking configuration defining polling frequency and data queue limits requiring user privacy consent.

applicationsTime object optional

macOS application usage time tracking configuration defining data collection frequency queue limits and report batch sizing.

applicationsTransfer object optional

macOS application network data transfer monitoring configuration tracking bandwidth usage per application for security and analysis.

networkStatus object optional

scripts object optional

macOS script execution configuration controlling compliance check frequency and automated task scheduling through MDM agent.

deviceInfo object optional

macOS device information collection configuration controlling battery usage Bluetooth discovery and system inventory reporting frequency.

{
    "status": true,
    "data": {
        "config": {
            "checkInterval": 300,
            "allowRefreshAction": true
        },
        "ios": {
            "location": {
                "active": true,
                "refreshInterval": 600,
                "queueLength": 100
            }
        },
        "macos": {
            "location": {
                "active": true,
                "refreshInterval": 600,
                "queueLength": 100
            }
        }
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}

Request

Authorization

Path Params2

Responses